HR - Employees - REST API

This operation allows to send Compensation data to Taliris.

REQUEST

url: /rest/v1/hr/compensation

body: JSON format, containing all fields as below

Headers

The table below provide the details of the headers to be used when making the request.

Here is the format of the body that you should send:

{
    "HEADER": {
        "SOURCE_SYSTEM": {name of the source system},
        "TARGET_SYSTEM": {fixed value "DALI"},
        "TRANSACTION_ID": {functional identifier},
        "COMPANY_CODE": {ROC company code},
        "ANALYTICAL_CODE": {ROC BU code},
        "REQUEST_DATE_TIME": {datetime when the message is sent},
        "CORRELATION_ID": {technical ID used during all the transaction},
        "FLOW_NAME": {fixed value "COMPENSATION"},
        "DISPATCHING_KEY": {empty}
    },
    "PAYLOAD": {
        "COMPENSATION_MASTER_DATA": {
            "EMPLOYEE_ERP_ID": {ID of employee in the ERP source},
            "NBR_MONTH_PAY_TH": {theoretical number of months},
            "NBR_HOUR_PAY_TH": {theoretical number of hours},
            "COMPANY_ERP_ID": {local code of the company (in the erp)},
            "POTENTIAL_BONUS": {potential bonus},
            "PAYMENT_DATE": {payment date - format 'YYYY-MM-DD'},
            "UPDATE_DATE": {modication date - format 'YYYY-MM-DDTHH:MI:SSZ'},
            "OSMOSE_CODE": {osmose Code in ROC},
            "EFFECTIVE_DATE": {effective date - format 'YYYY-MM-DD'},
            "CALENDAR_MONTH": {calendar month},
            "PAYROLL_TRANSACTIONAL_DATA": [
                {
                    "AMOUNT": {amount for each payment rubric},
                    "TOP_RUBRIC": {payroll section],
                    "ACCOUNTING_PERIOD": {accounting period},
                    "COMPUTATION_PERIOD": {computation period},
                    "CURR_ISO_CD": {currency ISO code},
                    "NBR_MONTH": {number of months},
                    "PAYROLL_START_DATE": {first day of the payment month - format 'YYYY-MM-DD'},
                    "TRANSFER_DATE": {payment date - format 'YYYY-MM-DD'},
                    "COUNTRY_ISO_CODE": {ISO code of the country},
                    "PAYROLL_TRANCHE": {payroll tranche},
                    "EFFECTIVE_DATE": {effective date - format 'YYYY-MM-DD'},
                    "PAYROLL_END_DATE": {end day for payment month - format 'YYYY-MM-DD'},
                    "PAYMENT_DATE": {end day of the payment month - format 'YYYY-MM-DD'},
                    "PERIODICITY": {Frequency of the series - Fixed value : MONTHLY_AMOUNT}
                }
            ]
        }
    }
}

RESPONSE

Here is the response format:

{
  "ERROR": {
    "CODE": {error code},
    "DESCRIPTION": {error description},
    "DETAILS": {error details}
  }
}

The different possible responses are:

MAPPING

Here are further informations on each field which is present in the request body: